/*
 * Copyright (c) 2020 - present, Inspur Genersoft Co., Ltd.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.iec.edp.caf.security.core.details;

import io.iec.edp.caf.security.core.GrantedAuthority;
import io.iec.edp.caf.security.core.UserDetailsSource;

import java.io.Serializable;
import java.util.Collection;
import java.util.Locale;
import java.util.Map;
import java.util.Optional;

/**
 * This is {@link User}.
 *
 * @author zhangtianyi
 * @since 1.0.0
 */
@SuppressWarnings({"unused", "UnusedReturnValue"})
public interface User extends Serializable {

    String getId();

    String getCode();

    String getName();

    Optional<String> getFullNameEn();

    void setFullNameEn(String fullNameEn);

    UserTypeEnum getType();

    Optional<Locale> getLocale();

    Optional<String> getTimezone();

    Optional<String> getCustomizedLocaleString();

    void setCustomizedLocaleString(String customizedLocaleString);

    boolean isAccountNonExpired();

    boolean isAccountNonLocked();

    boolean isCredentialsNonExpired();

    boolean isEnabled();

    UserDetailsSource getUserDetailsSource();

    Optional<String> getExternalAttributeAsString(String attributeName);

    void updateExternalAttribute(Map<String, String> attributes);

    Collection<? extends GrantedAuthority> getAuthorities();

    PersonalUser toPersonalUser() throws UserTypeMismatchException;

    ServiceUser toServiceUser() throws UserTypeMismatchException;

}
